home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / Global.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  5KB  |  245 lines
  1. //
  2. // (c) 1999 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // Global.h
  5. //
  6. // API for the package Global.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /flux/packages/Global.h 3     21/04/01 11:52 Derekm $
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #ifdef FLUX_COMPILE
  16.  
  17. FLUX_DECLARE_EXTENSION(Global);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "global" )
  22. #endif // _MSC_VER >= 1000
  23. #endif // FLUX_LIB
  24.  
  25. #else
  26.  
  27. // Include other packages
  28. uses String, List, Set;
  29.  
  30. // Enumeration for access to global
  31. enum eGlobalAccess 
  32. { 
  33.     GA_Read           = 1, 
  34.     GA_Write          = 2,
  35.     GA_Indestructible = 4,
  36.     GA_NoSave         = 8
  37. };
  38.  
  39. // Enumeration for the type of the global value
  40. enum eGlobalType
  41. { 
  42.     GT_Int, 
  43.     GT_Float, 
  44.     GT_Bool, 
  45.     GT_Handle,
  46.     GT_String, 
  47.     GT_List, 
  48.     GT_Set
  49. };
  50.  
  51. //
  52. // Creation functions
  53. //
  54.  
  55. //
  56. // Global.CreateInt( string name, int access, int initial_value )
  57. //
  58. // Create a global integer 
  59. //
  60. prototype Global.CreateInt( string name, int access, int initial_value );
  61.  
  62. //
  63. //  Global.CreateFloat( string name, int access, float initial_value )
  64. //
  65. // Create a global floating-point 
  66. //
  67. prototype Global.CreateFloat( string name, int access, float initial_value );
  68.  
  69. //
  70. // Global.CreateBool( string name, int access, bool initial_value )
  71. //
  72. // Create a global boolean 
  73. //
  74. prototype Global.CreateBool( string name, int access, bool initial_value );
  75.  
  76. //
  77. // Global.CreateHandle( string name, int access, hobject initial_value )
  78. //
  79. // Create a global handle 
  80. //
  81. prototype Global.CreateHandle( 
  82.     string name, int access, hobject initial_value );
  83.  
  84. //
  85. // Global.CreateString( string name, int access, string initial_value )
  86. //
  87. // Create a global string 
  88. //
  89. prototype Global.CreateString( string name, int access, string initial_value );
  90.  
  91. //
  92. // Global.CreateList( string name, int access, list initial_value )
  93. //
  94. // Create a global list 
  95. //
  96. prototype Global.CreateList( string name, int access, list initial_value );
  97.  
  98. //
  99. // Global.CreateSet( string name, int access, set initial_value )
  100. //
  101. // Create a global set 
  102. //
  103. prototype Global.CreateSet( string name, int access, set initial_value );
  104.  
  105. //
  106. // prototype Global.Destroy( string name )
  107. //
  108. // Destroy function
  109. //
  110. prototype Global.Destroy( string name );
  111.  
  112. //
  113. // Queries
  114. //
  115.  
  116. //
  117. // prototype bool Global.Exists( string name )
  118. //
  119. // Query global for existance
  120. //
  121. prototype bool Global.Exists( string name );
  122.  
  123. //
  124. // prototype eGlobalType Global.Type( string name )
  125. //
  126. // Query global for type
  127. //
  128. prototype eGlobalType Global.Type( string name );
  129.  
  130. //
  131. // Accessors
  132. //
  133.  
  134. //
  135. // int Global.Int( string name )
  136. //
  137. // Integer global accessor
  138. //
  139. prototype int Global.Int( string name );
  140.  
  141. //
  142. // float Global.Float( string name )
  143. //
  144. // Floating-point global accessor
  145. //
  146. prototype float Global.Float( string name );
  147.  
  148. //
  149. // bool Global.Bool( string name )
  150. //
  151. // Boolean global accessor
  152. //
  153. prototype bool Global.Bool( string name );
  154.  
  155. //
  156. // hobject Global.Handle( string name )
  157. //
  158. // Handle global accessor
  159. //
  160. prototype hobject Global.Handle( string name );
  161.  
  162. //
  163. // string Global.String( string name )
  164. //
  165. // String global accessor
  166. //
  167. prototype string Global.String( string name );
  168.  
  169. //
  170. // list Global.List( string name )
  171. //
  172. // List global accessor
  173. //
  174. prototype list Global.List( string name );
  175.  
  176. //
  177. // set Global.Set( string name )
  178. //
  179. // Set global accessor
  180. //
  181. prototype set Global.Set( string name );
  182.  
  183. //
  184. // Settors
  185. //
  186.  
  187. //
  188. // Global.SetInt( string name, int value )
  189. //
  190. // Set the global integer
  191. //
  192. prototype Global.SetInt( string name, int value );
  193.  
  194. //
  195. // Global.SetFloat( string name, float value )
  196. //
  197. // Set the global float
  198. //
  199. prototype Global.SetFloat( string name, float value );
  200.  
  201. //
  202. // Global.SetBool( string name, bool value )
  203. //
  204. // Set the global bool
  205. //
  206. prototype Global.SetBool( string name, bool value );
  207.  
  208. //
  209. // Global.SetHandle( string name, hobject value )
  210. //
  211. // Set the global handle
  212. //
  213. prototype Global.SetHandle( string name, hobject value );
  214.  
  215. //
  216. // Global.SetString( string name, string value )
  217. //
  218. // Set the global string
  219. //
  220. prototype Global.SetString( string name, string value );
  221.  
  222. //
  223. // Global.SetList( string name, list value )
  224. //
  225. // Set the global list
  226. //
  227. prototype Global.SetList( string name, list value );
  228.  
  229. //
  230. // Global.SetSet( string name, set value )
  231. //
  232. // Set the global set
  233. //
  234. prototype Global.SetSet( string name, set value );
  235.  
  236. //
  237. // Global.SetAccess(string name, int access)
  238. //
  239. // Set the access rights for the global
  240. //
  241. prototype Global.SetAccess(string name, int access);
  242.  
  243.  
  244. #endif // FLUX_LIB
  245.